home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / edit / vde_mc.zip / VMC.DOC < prev   
Text File  |  1990-12-09  |  8KB  |  200 lines
  1.  
  2.  
  3.                                    VMC.DOC
  4.                                    -------
  5.                       Instructions for VDE Macro Compiler
  6.                               VMC 1.00a (12/09/90)
  7.           for use with Eric Meyer's VDE editor version 1.53 and above
  8.  
  9.                               VMC.DOC and VMC.COM
  10.                                    Written by
  11.                                   Evan Slawson
  12.  
  13.                            Copyright 1990 Evan Slawson
  14.                               All rights reserved
  15.  
  16.  
  17. ||||||  ABOUT VMC  ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||:
  18.  
  19. VMC, the Macro Compiler for Eric Meyer's VDE editing program, converts
  20. VDE keyboard and function-key macro definition files from their native
  21. format to easy-to-edit text files or vice versa.
  22.  
  23. VMC.DOC covers use of VMC only.  For complete information about VDE's macro
  24. capabilities, please consult VDE documentation.
  25.  
  26. This version of the compiler works only with VDE versions that use the number
  27. 1.53 in their macro file headers.  At this time, this includes VDE versions
  28. 1.53, 1.54, 1.55 and 1.6.
  29.  
  30.  
  31. ||||||  USAGE POLICY  ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
  32.  
  33. The VMC utility and its documentation are copyright 1990 Evan Slawson, all
  34. rights reserved.  They may not be circulated in any incomplete or modified form,
  35. nor sold for profit, without written permission of the author.  VMC.COM and
  36. VMC.DOC must be circulated together.  There is no fee to individuals or
  37. companies for use of VMC.  Any software dealer or library may offer VMC for sale
  38. as long as the price charged for the disk containing VMC does not exceed US
  39. $5.00.  Any other sale of VMC, either alone or together with other software or
  40. hardware, requires a licensing agreement.
  41.  
  42. Address all correspondence to the author:
  43.  
  44. Evan Slawson
  45. 6320 Whitsett Ave. #4
  46. North Hollywood, CA 91606
  47.  
  48. or E-mail at Glendale Litera BBS  818-956-6164
  49.  
  50.  
  51. ||||||  SOURCES  ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||:
  52.  
  53. Please note that copies of VMC   CANNOT   be ordered directly from the author.
  54.  
  55. Glendale Littera QBBS - Glendale, CA  (818)956-6164 is the primary distribution
  56. point for VMC.  If it becomes necessary to update VMC, new versions will be
  57. posted here.
  58.  
  59.  
  60. ||||||  DISCLAIMER  ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
  61.  
  62.                    You undertake to use VMC at your own risk.
  63.             The author assumes no liability for damages of any kind
  64.                         resulting from your use of VMC.
  65.  
  66.  
  67. ||||||  USING VMC  ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||:
  68.  
  69. Place VMC.COM in either the current directory
  70. or a directory that is included in your PATH setting.
  71.  
  72. To use VMC, simply type   VMC <macrodatafilename>
  73.                    or     VMC <macrotextfilename>
  74. from the DOS command line.
  75.  
  76. Macro data files must have these identifiers:
  77.  
  78.    .VDF  for function key macros
  79.    .VDK  for keyboard macros
  80.    (These identifiers are required by VDE as well.)
  81.  
  82. Macro text files must have these identifiers:
  83.  
  84.    .VTF  for function key macros
  85.    .VTK  for keyboard macros
  86.  
  87. An easy way to remember these identifiers is to think of the D in
  88. .VDF and .VDK as "Data" and the T in .VTF and .VTK as "Text".
  89.  
  90. VMC determines the kind of conversion based on the input filename.
  91. The converted output file uses the name portion of the input file
  92. and has the correct identifier for the type of file it is, i.e.:
  93.  
  94.      Input       Output    Conversion
  95.      *.VDK   ->  *.VTK     Keyboard macro data file converted to text file
  96.      *.VTK   ->  *.VDK     Keyboard macro text file converted to data file
  97.      *.VDF   ->  *.VTF     Function key   data file converted to text file
  98.      *.VTF   ->  *.VDF     Function key   text file converted to data file
  99.  
  100. Entering   VMC   without a filename parameter will produce a single-screen
  101. syntax summary for quick reference.
  102.  
  103.  
  104. ||||||  MACRO TEXTFILE FORMAT  ||||||||||||||||||||||||||||||||||||||||||||||||:
  105.  
  106. Macro text files should be plain ASCII files, saved in /A or /N mode of VDE.
  107.  
  108. Macro text files use the same format for both .VTF and .VTK files.
  109.  
  110. Each macro must be typed on a single line.  Each line may contain up to 256
  111. text characters.  VMC aborts if a line compiles to more than 128 characters in
  112. the data file.  This conforms with the VDE limit of 128 characters for any one
  113. macro.  Since control and alt keys may be represented in the text file as
  114. two-character expressions, VMC allows text lines longer than 128 characters.
  115.  
  116. Each macro must begin with a label representing the key it is assigned to.  The
  117. label must be surrounded by [].  The label expression must begin in column 1.
  118.  
  119. For .VTF (function key) files the valid labels are [01]..[48].
  120.  
  121. Remember that VDE assigns function keys like this:
  122.  
  123.          [F1]...[F10]  =  F01...F10 in VDE notation
  124.    Shift-[F1]...[F10]  =  F11...F20
  125.     Ctrl-[F1]...[F10]  =  F21...F30
  126.      Alt-[F1]...[F10]  =  F31...F40
  127.  
  128. If you have an Enhanced (101-key) AT keyboard, also:
  129.           [F11],[F12]  =  F41,F42
  130.     Shift-[F11],[F12]  =  F43,F44
  131.      Ctrl-[F11],[F12]  =  F45,F46
  132.       Alt-[F11],[F12]  =  F47,F48
  133.  
  134. Function keys must be arranged in ascending numeric order in the .VTF file.
  135.  
  136. A .VTF file may have up to 48 lines.
  137.  
  138. Valid .VTK (keyboard macro) labels are in the ranges [0]..[9] and [A]..[Z].
  139. Label letters can be upper or lower case.  Macros must be in the order 0..9,
  140. A..Z in the .VTK file.  .VTK files can have up to 36 lines.
  141.  
  142.  
  143. ||||||  SPECIAL CHARACTERS IN MACRO TEXT FILES  ||||||||||||||||||||||||||||||||
  144.  
  145. There are several special characters in macro text files.
  146.  
  147. The  @  symbol indicates the next key will be an Alt key.  The
  148. next key MUST be in the ranges A-Z or a-z.
  149.  
  150. The  ^  symbol indicates the next key will be a Ctrl key.  The next key
  151. MUST be either ^, [, ], _ or \ or in the ranges A-Z or a-z.  You can also
  152. enter Ctrl keys directly in your text file, by pressing ^P followed by a
  153. letter.  VMC's output file will always convert to the ^ expession.
  154.  
  155. The Escape key can be entered as a control key (^[) or by pressing ^P then
  156. the Escape key.  Again, VMC will always convert to the ^ expression.
  157.  
  158. The  `  (back apostrophe) symbol tells VMC to place the next character in
  159. the data file without any conversion.  This is useful if you need an actual
  160. @ or ^ symbol in your macros.  To enter an actual back apostrophe, you must
  161. place two in a row.
  162.  
  163.  
  164. ||||||  NO REPEAT / QUIET MODES  ||||||||||||||||||||||||||||||||||||||||||||||:
  165.  
  166. To make a macro run in No-repeat mode or Quiet mode, put N or Q as
  167. the first character after the label.  (You can also use q or n.)  If
  168. you need a Q, q, N or n as the actual first letter of a macro, instead
  169. of as a No-repeat or Quiet mode designator, type a ` (back apostrophe)
  170. before it.
  171.  
  172.  
  173. ||||||  ERROR MESSAGES  ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
  174.  
  175. VMC produces error messages for many conditions, including invalid filenames,
  176. invalid macro order, bad macro labels, invalid character following ^ or @ and
  177. some other conditions.  If an error occured in macro processing VMC tells you:
  178.  
  179.   Error occured after macro:
  180.  
  181. and then shows you a macro label.  The label shown indicates the last correctly
  182. processed macro.  Whatever macro follows is where the error occured.
  183.  
  184.  
  185. ||||||  COMMENTING YOUR MACROS  ||||||||||||||||||||||||||||||||||||||||||||||||
  186.  
  187. If you would like to comment your macros, keep the comments in a file named
  188. with the name portion of your macro file and use an extension of .VCK or
  189. .VCF.  Think of the C representing Comments.  Then use VDE and AltW to view
  190. the .VT? and the .VC? files simultaneously.
  191.  
  192.  
  193. ||||||  ACKNOWLEDGEMENTS  ||||||||||||||||||||||||||||||||||||||||||||||||||||||
  194.  
  195. Thanks to Eric Meyer for VMC development suggestions and for VDE in the
  196. first place, and to Fred Haines and Ben Cohen at Glendale Litera BBS for
  197. coming up with the idea of writing a VDE macro compiler.
  198.  
  199.  
  200.